Welcome
Expand Getting StartedGetting Started
Expand SOLIDWORKS API HelpSOLIDWORKS API Help
Expand SOLIDWORKS Electrical API HelpSOLIDWORKS Electrical API Help
Expand SOLIDWORKS PDM Professional API HelpSOLIDWORKS PDM Professional API Help
Collapse PDM Pro API Web ServicePDM Pro API Web Service
Expand FeatureWorks API HelpFeatureWorks API Help
Expand SOLIDWORKS Costing API HelpSOLIDWORKS Costing API Help
Expand SOLIDWORKS Document Manager API HelpSOLIDWORKS Document Manager API Help
Expand SOLIDWORKS Inspection API HelpSOLIDWORKS Inspection API Help
Expand SOLIDWORKS Routing API HelpSOLIDWORKS Routing API Help
Expand SOLIDWORKS Simulation API HelpSOLIDWORKS Simulation API Help
Expand SOLIDWORKS Sustainability API HelpSOLIDWORKS Sustainability API Help
Expand SOLIDWORKS Toolbox API HelpSOLIDWORKS Toolbox API Help
Expand SOLIDWORKS Utilities API HelpSOLIDWORKS Utilities API Help
Expand eDrawings API HelpeDrawings API Help
Expand DraftSight API HelpDraftSight API Help
Expand Lisp Programming BasicsLisp Programming Basics
Expand Lisp Functions OverviewLisp Functions Overview
Expand Lisp Functions ReferenceLisp Functions Reference
Expand Visual Lisp Compatible FunctionsVisual Lisp Compatible Functions
Hide Table of Contents
PDM Pro API Web Service
Postapi/{vaultName}/files/infofrompath
PDM Pro API Web Service > File Resource Group : api/{vaultName}/files/infofrompath (Post)
Description
Gets information about a file in the specified vault.
Parameters
NameDescriptionData Type
vaultName(URI parameter) Vault name (required)string
Id

(Response) File ID

 

Member of ObjectInfo model; see Remarks

integer
Name

(Response) File name

 

Member of ObjectInfo model; see Remarks

string
Size

(Response) File size

 

Member of ObjectInfo model; see Remarks

integer
ModifiedDate

(Response) Modification date

 

Member of ObjectInfo model; see Remarks

date
Version

 (Response) Version

integer
State

(Response) Workflow state

 

Member of ObjectInfo model; see Remarks

string
StateId

(Response) State ID

 

Member of ObjectInfo model; see Remarks

integer
ParentFolderId

(Response) Parent folder ID

 

Member of ObjectInfo model; see Remarks

integer
Path

(Response) Folder path

 

Member of ObjectInfo model; see Remarks

string
Type

(Response) ObjectType model; one of:

   Folder = 0

   File = 1

   Bom = 3

 

Member of ObjectInfo model; see Remarks

ObjectType
IsLocked

(Response) Whether the file is checked out

 

Member of ObjectInfo model; see Remarks

integer
LockedBy

(Response) ID of user who checked out the file

 

Member of ObjectInfo model; see Remarks

integer
IsShared

(Response) Whether the file is shared

 

Member of ObjectInfo model; see Remarks

integer
IsToolbox

(Response) Whether the file is a toolbox item

 

Member of ObjectInfo model; see Remarks

integer
IsDeleted

(Response) Whether the file is deleted

 

Member of ObjectInfo model; see Remarks

integer
Remarks

This operation:

 

  • takes a body parameter that contains a file path relative to the vault root. For example, if you want information about File1.txt which is stored in c:\PDMLocalViews\vault_name\Test1\Test2, where vault_name is the name of the vault, then the body of this API should contain \\Test1\Test2\\File1.txt.
  • returns an ObjectInfo for the file.
See Also
File Resource Group | PDM Pro API Web Service



Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   api/{vaultName}/files/infofrompath (Post)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2023 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.

0.20.21